Docs
Getting Started
API
get https://api.pix.iugu.com/api/v2/webhook/{chave}

Exibir informações acerca do Webhook Pix.

Endpoint para recuperação de informações sobre o Webhook Pix.

Permissão necessária:

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Respostas
200
Dados do webhook.
webhookUrl

Obrigatório

String

Ex: https://pix.example.com/api/webhook/
chave

Obrigatório

String <= 77 characters

# Formato do campo chave * O campo chave determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança. * Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP. * O formato das chaves pode ser encontrado em "Formatação das chaves do DICT no BR Code" do [Manual de Padrões para iniciação do Pix](https://www.bcb.gov.br/estabilidadefinanceira/pix).

criacao

Obrigatório

String

Data e hora em que o webhook foi cadastrado. Respeita RFC 3339.
403
Requisição de participante autenticado que viola alguma regra de autorização.
type
String

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

Ex: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado
title
String

Descrição resumida do problema.

Ex: Not found
status
Integer

Código HTTP do status retornado.

Ex: 404
detail
String

Descrição completa do problema.
correlationId
String

Identificador de correlação do problema para fins de suporte
violacoes
Array of objects

razao
String

Descrição do erro

Ex: Valor da cobrança não pode ser 0.00
propriedade
String

Nome da propriedade

Ex: cob.chave
valor
String

Valor da propriedade

Ex: 061996671234
404
Recurso solicitado não foi encontrado.
type
String

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

Ex: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado
title
String

Descrição resumida do problema.

Ex: Not found
status
Integer

Código HTTP do status retornado.

Ex: 404
detail
String

Descrição completa do problema.
correlationId
String

Identificador de correlação do problema para fins de suporte
violacoes
Array of objects

razao
String

Descrição do erro

Ex: Valor da cobrança não pode ser 0.00
propriedade
String

Nome da propriedade

Ex: cob.chave
valor
String

Valor da propriedade

Ex: 061996671234
503
Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.
type
String

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

Ex: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado
title
String

Descrição resumida do problema.

Ex: Not found
status
Integer

Código HTTP do status retornado.

Ex: 404
detail
String

Descrição completa do problema.
correlationId
String

Identificador de correlação do problema para fins de suporte
violacoes
Array of objects

razao
String

Descrição do erro

Ex: Valor da cobrança não pode ser 0.00
propriedade
String

Nome da propriedade

Ex: cob.chave
valor
String

Valor da propriedade

Ex: 061996671234

Voltar

Configurar o Webhook Pix.

Avançar

Cancelar o webhook Pix.